home *** CD-ROM | disk | FTP | other *** search
/ Aminet 20 / Aminet 20 (1997)(GTI - Schatztruhe)[!][Aug 1997].iso / Aminet / dev / c / ged4indent.readme < prev    next >
Text File  |  1997-07-13  |  4KB  |  135 lines
  1. Short:    Indent C-source in GoldEd4
  2. Author:   Thomas Aglassinger <agi@giga.or.at>
  3. Uploader: Thomas Aglassinger <agi@giga.or.at>
  4. Version:  1.1
  5. Type:     dev/c
  6. Kurz:     C-Quellcode in GoldEd4 einruecken
  7. Requires: GoldEd 4.x, GNUindent
  8.  
  9. TITLE
  10.  
  11.   ged4indent
  12.  
  13. VERSION
  14.  
  15.   1.1
  16.  
  17. AUTHOR
  18.  
  19.   Thomas Aglassinger <agi@giga.or.at>
  20.  
  21. DESCRIPTION
  22.  
  23.   Ged4indent is an ARexx-script which indents a C-source currently
  24.   displayed by GoldEd using GNUindent.
  25.  
  26. FEATURES
  27.  
  28.   None; simply does it's job.
  29.  
  30. SPECIAL REQUIREMENTS
  31.  
  32.   o GoldEd, Version 4.x (aminet:text/edit/)
  33.   o GNUindent (aminet:dev/c/)
  34.  
  35. AVAILABILITY
  36.  
  37.   aminet:dev/c/ged4indent.lha
  38.  
  39. PRICE
  40.  
  41.   Freeware
  42.  
  43. DISTRIBUTABILITY
  44.  
  45.   This stuff is Public Domain.
  46.  
  47. DISCLAIMER
  48.  
  49.   No responsibilities are taken for trashed sources, damaged Amigas
  50.   or any other components or data involved while using ged4indent.
  51.  
  52. CREDITS
  53.  
  54.   This script is based on material written by Michael Bauer. His
  55.   scripts are available from `aminet:dev/c/GEDindent.lha', but
  56.   does no longer work with GoldEd, release 4.
  57.  
  58.   As the original author did not update them for more than two years,
  59.   and his email-address does not seem to be valid any more, someone
  60.   else had to write this.
  61.  
  62. INSTALLATION
  63.  
  64.   Copy the ARexx-script `ged4indent.ged' to `GoldEd:ARexx/', and
  65.   build up a new menu entry for it, for example:
  66.  
  67.   COMMAND: GoldEd:Arexx/ged4indent.ged
  68.   TYPE   : Arexx
  69.   OUTPUT : CON:0/2048/384/128/indent/AUTO/WAIT/CLOSE/SCREENGOLDED.1
  70.  
  71.   Error messages will then appear on the screen of GoldEd.
  72.  
  73. CONFIGURATION
  74.  
  75.   By default, `indent' will be invoked using options which will match
  76.   the style GoldEd supports in it's initial configuration. If you do
  77.   not like this style, you can set an environment variable named
  78.   `ged4indent.prefs' with your preferred style, for example:
  79.  
  80.     setenv ged4indent.prefs "-bl -bli0 -i4 -sob -sc -npsl -npcs -lp"
  81.  
  82.   You can add a line like the above to your s:user-startup.
  83.  
  84.   Refer to the manual of indent for the meaning of these options.
  85.  
  86. ERROR HANDLING
  87.  
  88.   In case of `indent' shows up any error messages, a window will open
  89.   and display these messages. The source code in the current editor
  90.   window remains untouched.
  91.  
  92.   The corrupt output file will remain as `t:ged4indent.XXXX' for
  93.   further examination. However, it is recommended to run a compiler on
  94.   the faulty source, as this will usually result in more detailed
  95.   messages.
  96.  
  97.   You can do a
  98.  
  99.     delete t:ged4indent.#?
  100.  
  101.   from time to time to save some memory.
  102.  
  103.   (If `indent' did not return any errors, the temporary file is
  104.   removed automatically.)
  105.  
  106. PROBLEMS
  107.  
  108.   The version of `indent' included with the Geek Gadgets v1 always
  109.   opens an output window on the screen, even if indent does not show
  110.   any messages. I do not know why. Use the SAS-compiled port in
  111.   aminet:dev/c.
  112.  
  113. HISTORY
  114.  
  115.   v1.1, 11-Jun-1997
  116.   - added support for environment variable `ged4indent.prefs'
  117.   - indented version is first created in a temporary file, and only
  118.     read into editor again if no error occurred
  119.  
  120.   v1.0, 26-Jan-1997
  121.   - initial release
  122.  
  123.  
  124. ============================= Archive contents =============================
  125.  
  126. Original  Packed Ratio    Date     Time    Name
  127. -------- ------- ----- --------- --------  -------------
  128.      628     274 56.3% 26-Jan-97 23:03:14  ged4indent.info
  129.     2435    1125 53.7% 11-Jun-97 18:07:10 +ged4indent.ged
  130.      519     287 44.7% 26-Jan-97 00:05:16 +ged4indent.ged.info
  131.     3032    1570 48.2% 11-Jun-97 18:16:06 +ged4indent.readme
  132.      468     231 50.6% 26-Jan-97 00:05:16 +ged4indent.readme.info
  133. -------- ------- ----- --------- --------
  134.     7082    3487 50.7% 13-Jun-97 23:14:38   5 files
  135.